React liveness/provide default device info #6633

riasatali42 · 2025-07-22T12:59:39Z

Description of changes

This PR introduces features to pass in and out the device information (device Id, device label, kind, group Id) for the camera of the liveness check. Also, provides support to add callback methods for camera changes or default device not found.

Key additions:

Pass Default device id and label so that the device will be automatically selected.
If device Id and device label both are present, device label will be prioritized.
Pass out device info (device Id, device label, group Id, kind) once the liveness check is completed.
Callback method added for default device not found if the device with the passed in device id/ label not found.
Callback method added for camera changes if the camera is changed. So that we can track the updated camera device with device info.

Issue ##6587, Pass deviceId in and out of liveness check

Description of how you validated changes

Created unit tests to test the added features.

Checklist

Have read the Pull Request Guidelines
PR description included
yarn test passes and tests are updated/added
PR title and commit messages follow conventional commit syntax
If this change should result in a version bump, changeset added (This can be done after creating the PR.) This does not apply to changes made to docs, e2e, examples, or other private packages.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

…ice automatically

…mera is found

…hing

changeset-bot · 2025-07-22T12:59:43Z

🦋 Changeset detected

Latest commit: 3662944

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@aws-amplify/ui-react-liveness	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Simone319 · 2025-07-22T14:48:59Z

Hello @riasatali42 , thanks for creating the PR! There's conflicts in the branch. Could you resolve the conflict and resubmit the PR?

…aNotFoundCallback and device change callback methods after resolving merge conflicts

riasatali42 · 2025-07-28T13:08:37Z

Hello @Simone319 , I have updated the branch with the current main branch and resolved all the conflicts. I've updated this PR instead of creating a new branch. Please let me know if I should do otherwise.

…github.com/SmarterServices/amplify-ui into react-liveness/provide-default-device-info

riasatali42 · 2025-07-29T13:49:47Z

@Simone319, I saw after running the tests that there were some ESLint issues. I've fixed those and updated the branch.
cc. @jasonfill

Simone319 · 2025-07-30T13:32:30Z

...es/react-liveness/src/components/FaceLivenessDetector/LivenessCheck/LivenessCameraModule.tsx

+              data: { newDeviceId: selectedDeviceId, newStream },
+            });
+          } catch (error: any) {
+            throw new Error('Error updating device:');


Let's include the original error message. ex:

throw new Error(`Error updating device: ${error.message}`);

Simone319 · 2025-08-01T12:27:29Z

packages/react-liveness/src/components/FaceLivenessDetector/service/machine/machine.ts

+            onCameraChange(deviceInfo);
+          }
+        } catch (callbackError) {
+          // console.error('Error in onCameraChange callback:', callbackError);


Here, we call still log the error, so that the error is not silently swallowed. However, we need to disable the eslint rule, such as:

// eslint-disable-next-line no-console console.error('Error in onCameraChange callback:', callbackError);

Simone319 · 2025-08-01T12:30:08Z

packages/react-liveness/src/components/FaceLivenessDetector/service/machine/machine.ts

+          // console.error('Error in onCameraNotFound callback:', callbackError);
+          // Don't rethrow to prevent state machine from getting stuck


Same as above.

Simone319 · 2025-08-01T13:31:01Z

packages/react-liveness/src/components/FaceLivenessDetector/service/machine/machine.ts

+
+        try {
+          const deviceInfo = getSelectedDeviceInfo(context);
+          onUserCancel(deviceInfo);


What's the use case of deviceInfo in onUserCancel callback?

The main goal was to make all the callbacks more consistent. I've discarded it as we won't need this.

Simone319 · 2025-08-07T12:28:00Z

...es/react-liveness/src/components/FaceLivenessDetector/LivenessCheck/LivenessCameraModule.tsx

@@ -145,6 +145,40 @@ export const LivenessCameraModule = (
    recording: 'flashFreshnessColors',
  });

+  // Update the device if the selectedDeviceId changes
+  React.useEffect(() => {


Why do we need to create a new effect here instead of reusing the existing onCameraChange callback?

I think we can discard that as the onCameraChange is already handling everything. So, I discarded.

Simone319 · 2025-08-07T12:40:43Z

packages/react-liveness/src/components/FaceLivenessDetector/service/machine/machine.ts

+          const deviceInfo = getSelectedDeviceInfo(context);
+          onUserCancel(deviceInfo);
+        } catch (callbackError) {
+          // console.error('Error in onUserCancel callback:', callbackError);


Same as above

…rom the onUserCancel callback

riasatali42 · 2025-08-07T16:35:14Z

Hello @Simone319 , I've updated the PR as per the feedback.
cc. @jasonfill

adrianjoshua-strutt · 2025-08-12T15:29:07Z

Hi @riasatali42,

thank you for addressing our concerns. Could you add end-to-end tests to verify the behavior of your changes?

This guide should help you getting started: https://github.com/aws-amplify/amplify-ui/tree/main/packages/e2e

If you got any questions, feel free to reach out.

Thank you!

riasatali42 · 2025-08-15T18:05:40Z

Hello @adrianjoshua-strutt ,
I followed all the steps to configure and successfully pushed to amplify using "amplify push". But when I'm running the tests, I'm seeing this issue on this API endpoint:
api: POST /dev/livenessnolight/create?challengeType=FaceMovementAndLightChallenge
RESPONSE: 502 {"message": "Internal server error"}

Could you please guide me here to resolve this issue?

jasonfill and others added 18 commits June 14, 2025 09:37

feat: add ability to pass device in and out of liveness check

58d9ba1

chore: clean up some formatting issues

f00e7fd

chore: fix additional formatting issues

16f1c07

chore: fix more formatting

1216c8f

chore: fix some formatting items

54d64f3

chore: additional formatting changes

afd93c1

chore: some resolutions were removed, replaced them

e8a5653

chore: formatting

b11b3ce

chore: remove duplicate items in package

85f47e0

chore: formatting

8ca425d

chore: add ability to provide default device label to select that dev…

933013b

…ice automatically

chore: added callback method for camera changed and if not default ca…

afb5077

…mera is found

chore: added selectableDevices array check

8c9f3e9

chore: added default device info in machine tests for unit testing

a89ff4d

chore: default device info for unit testing default device pass in

8905251

chore: unit tests added for default device not found and camera switc…

36e0fd3

…hing

chore: added device selection priority unit tests

497bfb0

docs: added changeset for minor changes

f0f7923

riasatali42 requested a review from a team as a code owner July 22, 2025 12:59

pranavosu added the external-contributor label Jul 22, 2025

Simone319 added run-tests Adding this label will trigger tests to run and removed external-contributor labels Jul 22, 2025

riasatali42 and others added 4 commits July 28, 2025 15:35

fix: resolved merge conflicts

3c75e1d

fix: fixed mock device info after resolving merge conflicts

0a3ad1b

chore: added updated unit tests for passed in device label, callCamer…

724dca3

…aNotFoundCallback and device change callback methods after resolving merge conflicts

Merge branch 'main' into react-liveness/provide-default-device-info

7a701c1

jasonfill mentioned this pull request Jul 28, 2025

Pass deviceId in and out of liveness check #6587

Open

2 tasks

riasatali42 added 3 commits July 29, 2025 19:18

fix: fixed ESlint issue on livenesscameramodule

d1bede1

fix: fixed eslint issue on adding type on error and replaced operator

af9b3bf

Merge branch 'react-liveness/provide-default-device-info' of https://…

bfd66d5

…github.com/SmarterServices/amplify-ui into react-liveness/provide-default-device-info

Simone319 reviewed Aug 7, 2025

View reviewed changes

fix: resolved PR feedback, added console error, removed device info f…

3662944

…rom the onUserCancel callback

		// console.error('Error in onCameraNotFound callback:', callbackError);
		// Don't rethrow to prevent state machine from getting stuck

React liveness/provide default device info #6633

Are you sure you want to change the base?

React liveness/provide default device info #6633

Conversation

riasatali42 commented Jul 22, 2025

Description of changes

Key additions:

Issue ##6587, Pass deviceId in and out of liveness check

Description of how you validated changes

Checklist

Uh oh!

changeset-bot bot commented Jul 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

Simone319 commented Jul 22, 2025

Uh oh!

riasatali42 commented Jul 28, 2025

Uh oh!

riasatali42 commented Jul 29, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

riasatali42 commented Aug 7, 2025

Uh oh!

adrianjoshua-strutt commented Aug 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

riasatali42 commented Aug 15, 2025

Uh oh!

Uh oh!

changeset-bot bot commented Jul 22, 2025 •

edited

Loading

adrianjoshua-strutt commented Aug 12, 2025 •

edited

Loading